home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / prog / atari / m2 / cat3src / cat / doku / itkdef.txt < prev    next >
Text File  |  1997-10-26  |  7KB  |  161 lines
  1. Gruppe: TAUSCHBAU
  2. ID:   A50369@K2
  3. Wg.:  ITK, neue Version
  4. Von:  Gereon Steffens @ K2 (Do, 20.07.95 17:33)
  5. MId:  199507201733.a50369@k2.maus.de
  6.  
  7. Seit eben gerade gibt's in K2 eine neue Version des ITK zu bewundern (Danke,
  8. Marcus!!). Hier die Doku dazu:
  9.  
  10. ITK-Zeilen:
  11. ID des Kommandos                                *
  12. N Name des Kommandos                            *
  13. A Aufz„hlung der Werte eines Aufz„hlungstyps
  14. B Beschreibung der Werte eines Aufz„hlungstyps
  15. C Konstante Teile der Syntax                    *
  16. D Defaultwert fr ein Feld                      *
  17. F Datentyp eines Feldes                         *
  18. H Ausfhrliche Beschreibung des Kommandos       *
  19. K Kurze Beschreibung eines Parameters           *
  20. L Ausfhrliche Beschreibung eines Parameters    *
  21. T Art des Kommandos                             *
  22. V Version des Kommandos                         *
  23.  
  24. # ist eine ganze Zahl, die dieses Kommando eindeutig identifiziert.
  25.  
  26. N ist eine nicht zu lange Bezeichnung fr das Kommando; sie k”nnte z.B.
  27.   als Auswahl in einem Men verwendet werden.
  28.  
  29. C beschreibt konstante Teile der Syntax.
  30.  
  31. H ist eine ausfhrlichere Beschreibung des Kommandos; das Frontend k”nnte sie
  32.   als Online-Hilfe im Men fr das entsprechende Kommando zur Verfgung
  33.   stellen.
  34.  
  35. V enth„lt eine ganze Zahl, die als Versionsnummer dieses Kommandos dient.
  36.   Žndert sich die Syntax oder die Bedeutung, so ist diese Nummer zu erh”hen.
  37.  
  38. T gibt die Art des Kommandos an:
  39.   TK besagt, daž es sich um ein Kommando handelt, das der Anwender per
  40.   Konfiguration festlegen k”nnen sollte und welches dann automatisch
  41.   immer wieder benutzt wird.
  42.  
  43.   TE kennzeichnet ein Kommando, das pro Tausch manuell aktiviert werden
  44.   k”nnen sollte, aber nur einmal im Infile auftauchen sollte;
  45.  
  46.   TB schliežlich bedeutet, daž der User mehrere dieser Kommandos pro
  47.   Tausch absetzen kann, diese aber vom Frontend nur so h„ufig abgesetzt
  48.   werden, wie der User sie explizit eingibt.
  49.  
  50. Fc   gibt den Datentyp eines Parameters an (s. unten)
  51. Ks   gibt eine kurze Bezeichnung eines Parameters; das Frontend kann sie
  52.      benutzen, um im Dialog das entsprechende Feld zu beschriften.
  53. Ls   gibt eine ausfhrlichere Beschreibung des Parameters. Das Frontend k”nnte
  54.      diese als Onlinehilfe zu dem einzelnen Feld anbieten.
  55. Ds   gibt einen Defaultwert fr den Parameter vor; die Syntax ist die, die auch
  56.      im Infile fr diesen Parameter zu verwenden ist.
  57. As[:s...]
  58.      Gibt die Infile-Syntax fr einen Wert eines Aufz„hlungstyps an.
  59.      Jeder Wert kann mehrere Zust„nde annehmen. Die Syntax verschiedener
  60.      Zust„nde wird dabei durch Doppelpunkte getrennt. Beispiel:
  61.          A+:
  62.      , d.h. es existieren zwei Zust„nde. Der erste wird durch '+' angegeben,
  63.      der zweite durch einen Leerstring. Bei Werten mit zwei Zust„nden sollte
  64.      die Beschreibung derart gew„hlt werden, daž das Frontend den ersten
  65.      der Zust„nde durch 'markiert', den zweiten durch 'nicht markiert' in
  66.      einer Dialogbox symbolisieren kann. Bei Werten mit drei Zust„nden
  67.      sollte sie so gew„hlt werden, daž der erste durch 'positiv markiert',
  68.      der zweite durch 'negativ markiert' und der dritte durch 'nicht markiert'
  69.      symbolisiert werden kann.
  70.  
  71.      Diese Angabe bezieht sich auf die Syntax und braucht also dem User
  72.      nicht angezeigt zu werden.
  73. Bs   bezeichnet einen Wert eines Aufz„hlungstyps.
  74.  
  75.      Die Unterteilung von Aufz„hlungstypen erfolgt zweidimensional ("Werte
  76.      des Aufz„hlungstyps" X "Zust„nde eines Wertes"), da dies der Praxis
  77.      am n„chsten kommt. Beschreibungen werden nur fr *Werte* angegeben,
  78.      w„hrend die verschiedenen Zust„nde eines Wertes nur durch unterschiedliche
  79.      Markierungen an der jeweiligen einzigen Beschreibung dargestellt werden.
  80.  
  81.      šbrigens existiert die Option "Set Of" nur entlang der ersten Dimension.
  82.  
  83.      Diese Aspekte sind beim Entwurf von Kommandobeschreibungen zu
  84.      bercksichtigen. Es ist von Fall zu Fall zu entscheiden, ob es intuitiver
  85.      ist, die Werte entlang der ersten, der zweiten oder beider Dimensionen
  86.      anzuordnen.
  87.  
  88.      Beispielsweise ist es sinnvoll, eine Auswahl im Sinne von "Ein/Aus"
  89.      (z.B. "Anfordern/Nicht Anfordern") entlang der zweiten Dimension anzu-
  90.      ordnen: es gengt vollkommen, wenn der Anwender ein Feld "Anfordern"
  91.      erh„lt, das er aktivieren kann oder nicht.
  92.  
  93.      Hingegen ist es bei einer Auswahl zwischen zwei nicht direkt entgegen-
  94.      gesetzten M”glichkeiten ("Neue anfordern/Alle anfordern") sinnvoll,
  95.      dies entlang der ersten Dimension zu tun, um zwei verschiedene Dialog-
  96.      felder mit jeweils eigenen Beschreibungen zu erzeugen.
  97.  
  98. Die generelle Struktur eines ITK-Eintrags ist somit wie folgt:
  99.  
  100. #<Kommando-Nummer>
  101.   Diese Zeile leitet ein neues Kommando ein. Alle folgenden Zeilen bis zum
  102.   Ende oder bis zur n„chsten #-Zeile beziehen sich auf dieses Kommando.
  103. N<Kommando-Name>
  104. H<Kommando-Beschreibung>
  105. T<Kommando-Art>
  106. V<Kommando-Version>
  107.  
  108. Auf diesen mehr oder weniger konstanten Block folgen dann ein oder mehrere
  109. syntaxbeschreibende Bl”cke. Ein syntaxbeschreibender Block wird eingeleitet
  110. durch eine C- oder eine F-Zeile. Wird er durch eine C-Zeile eingeleitet,
  111. so produziert er einen konstanten String und besteht nur aus dieser C-Zeile.
  112. Ein Block, der durch eine F-Zeile eingeleitet wird, beschreibt einen vom
  113. User einzugebenden Parameter.
  114.  
  115. F<Datentyp>
  116.   Diese Zeile leitet einen neuen Parameter ein. Alle folgenden Zeilen bis
  117.   zum Ende des Kommandos oder bis zur n„chsten C- oder F-Zeile beziehen sich
  118.   auf diesen Parameter.
  119. D<Defaultwert>
  120. K<kurze Beschreibung>
  121. L<lange Beschreibung>
  122. <ggf. noch A- und B-Zeilen, immer paarweise, immer A-Zeile zuerst>
  123.  
  124. Die Produkte aller C/F-Bl”cke, in der gegebenen Reihenfolge konkateniert,
  125. ergeben das Infile-Kommando.
  126.  
  127. H und L drfen jeweils mehrfach auftreten. Ein Blank zu Beginn einer Zeile
  128. weist das Frontend an, diese Zeile weder neu umzubrechen noch sie zwecks
  129. neuen Umbruchs an die vorhergehende Zeile anzuh„ngen.
  130.  
  131. Als Datentypen c stehen zur Verfgung:
  132.  
  133.                                      Darstellung im Infile
  134. A     - Aufz„hlungstyp               wie in A-Zeilen angegeben
  135. M     - Set of Aufz„hlung;
  136.         es gilt alles wie fr A,
  137.         nur daž das Frontend erlauben
  138.         muž, mehrere Werte gleichzeitig
  139.         zu aktivieren.
  140. D     - Datum                        JJJJMMTTHHMM[SS]
  141. d     - Datum                        TT[.MM[.JJJJ]]
  142. Sn    - String der L„nge n           wie eingegeben
  143. Pn    - Pažwort der L„nge n          wie eingegeben
  144.         (wird ggf. nicht angezeigt)
  145. pn    - neues Pažwort der L„nge n    wie eingegeben
  146.         (Frontend kann ggf. zweimal
  147.         fragen)
  148. U     - Username                     wie eingegeben
  149. I     - ganze Zahl, 2 Byte           dezimal, Ascii, mit
  150.                                      Vorzeichen, auch wenn positiv
  151. Im,n  - ganze Zahl aus dem Intervall dezimal, Ascii, mit
  152.         [m;n].                       Vorzeichen, auch wenn positiv
  153. G     - Gruppenname                  im Klartext
  154. g     - Name einer Gruppe, in der    im Klartext
  155.         User Chef ist
  156.  
  157. Ein 'o' hinter dem Datentyp bedeutet, daž in das Feld keine Daten eingegeben
  158. werden mssen. Im Infile ist dann ein Leerstring einzutragen.
  159.  
  160. Gereon
  161.